package org.jgs2007.onemall.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author: luKai
 * @date： 2020/10/16 10:21
 * @version： 1.0
 * @description： Swagger2配置类
 */
@Configuration
@EnableSwagger2 // 开启Swagger2
public class Swagger2Config {

    /**
     * 通过 createRestApi方法来构建一个Docket Bean
     * 方法名任意
     */
    @Bean // 将方法返回地Docket对象注入到spring容器
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                //调用apiInfo方法,创建一个ApiInfo实例,里面是展示在文档页面信息内容
                .apiInfo(apiInfo())
                .select()
                //设置暴露接口的控制器所在包；如果某个接口不想暴露,可以使用@ApiIgnore注解
                .apis(RequestHandlerSelectors.basePackage("org.jgs2007.onemall.controller"))
                //路径筛选，这里放行所有路径
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 构建 api文档的详细信息
     *
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("水果商城API")
                //条款地址
                .termsOfServiceUrl("http://jlog.online")
                //版本
                .version("1.0")
                //描述
                .description("水果商城API的测试")
                .build();
    }
}
